Represents a contact person or an organizational unit. This class corresponds to the forms LSAContact and LSAOrganization
in the LSAAddress application.
- Version:
-
1.2.3, 25.JUL.2000
<BR>
- History:
| 25.JUL.2000 | RGR | SaveToPredefinedFields changed
|
| 25.JUL.2000 | RGR | constructor changed to determine unitType from document
|
| 08.JUN.2000 | RGR | Delete method modified to delete child objects and check out object in instance manager
|
| 31.MAY.2000 | RGR | methods saveToPredefinedFields and Save changed
|
Public Property Set ContextDoc AsNotesDocument
Sets the document which corresponds to this unit.
Public Property Get ContextDoc AsNotesDocument
Public Property Set DocID AsString
Sets the document which corresponds to this unit.
Public Property Get DocID AsString
Public Property Set UnitType AsString
Sets the type of the unit:
"LSAContact" for a contact unit
"LSAOrganization" for an organization unit
If the type doesn't much one of the options the default is Organization
Public Property Get UnitType AsString
Public Property Get UnitInstanceID AsString
Public Property Set AddrMgrID AsString
The id with which the LSAAddressManager has been checked in in the
InstanceManager.
Public Property Get AddrMgrID AsString
Public Property Get AddrMgr AsVariant
Returns a handle to the address manager object
Public Property Set PersonData AsLSAAddrPersonData
Public Property Get PersonData AsLSAAddrPersonData
Public Property Set OrganizationData AsLSAAddrOrganizationData
Public Property Get OrganizationData AsLSAAddrOrganizationData
Public Property Set AddressData AsLSAAddressData
Public Property Get AddressData AsLSAAddressData
Public Property Set GlossaryReferenceS AsLSAGlossaryReferenceS
Public Property Get GlossaryReferenceS AsLSAGlossaryReferenceS
Public Property Set SyncInfo AsLSASync
Public Property Get SyncInfo AsLSASync
Public Property Set CampaignS AsVariant
Sets the array of campaign in which the unit is member in
Public Property Get CampaignS AsVariant
New
Public Sub New(doc As NotesDocument,unitType As String,addrMgrID As String)
Instantiates a new object by filling the unit with the information from the context
document. If a document is provided the unitType is determined by the document
values. If doc has the value nothing the parameter unitType determines the
type of the new unit.
- Parameters:
| doc | NotesDocument | the document storing the persintant data of the unit
|
| unitType | String | LSAContact or LSAOrganization depending on the type of unit
|
| addrMgrID | String | handle to access the LSAAddressManager through the InstanceManager
|
- History:
| 25.JUL.2000 | RGR | if doc isn't nothing than the constructor determines the unitType
|
Delete
Public Sub Delete
Default destructor of the class. Deletes all child objects and checks out the object
in the instance manager.
- History:
| 08.JUN.2000 | RGR | Delete the children and check out
|
getPersonData
Public Function getPersonData As String
Returns the Block "LotusC" if the unit is a contact. Otherwise an empty string is returned.
- Returns:
| String | a value of the form ##LotusC#FirstName#...
|
- See also:
getOrganizationData
Public Function getOrganizationData As String
Returns the Block "LotusC" if the unit is a contact. Otherwise an empty string is returned.
- Returns:
| String | a value of the form ##LotusC#FirstName#...
|
- See also:
getDisplayName
Public Function getDisplayName As String
getOrganizationS
Public Function getOrganizationS As Variant
Returns an array of all organization a unit is member of
- Returns:
| Variant | array with all organizations of a unit
|
getReference
Public Function getReference As String
Returns a serial data string consisting of the name of the organization or person and the internal ID.
E.g. ##Boss Betram B#A3243490D63545342
getCustomerContactSearchCriterias
Public Function getCustomerContactSearchCriterias As Variant
Returns the contact search criterias which have been specified by a customer. This
function is called from the class LSAAddressData and the values are appended to
the property ContactSearchCriterias of LSAAddressData.
setCustomerContactSearchCriterias
Public Sub setCustomerContactSearchCriterias(newCriterias As Variant)
Sets the contact search criterias specific to the customer. This values are
added to the property ContactSearchCriterias of the class LSAAddressData.
- Parameters:
| newCriterias | Variant | String array of possible search criterias
|
getCustomerOrganizationSearchCriterias
Public Function getCustomerOrganizationSearchCriterias As Variant
Returns the organization search criterias which have been specified by a customer. This
function is called from the class LSAAddressData and the values are appended to
the property ContactSearchCriterias of LSAAddressData.
setCustomerOrganizationSearchCriterias
Public Sub setCustomerOrganizationSearchCriterias(newCriterias As Variant)
Sets the organization search criterias specific to the customer. This values are
added to the property OrganizationSearchCriterias of the class LSAAddressData.
- Parameters:
| newCriterias | Variant | String array of possible search criterias
|
getCustomerSerialData
Public Function getCustomerSerialData As String
Returns the serial data string which is specific to a customer and is added to the DefaultData
property of the class LSAAddressData. This function is called by the class LSAAddressData!
- Returns:
| String | serialdata with customer data
|
setCustomerSerialData
Public Sub setCustomerSerialData(newData As String)
Sets the serial data string specific to the customer which is
added to the property DefaultData of the class LSAAddressData.
- Parameters:
| newData | String | SerialDataString which must use the Delimiter of the class LSAAddressData.
|
Save
Public Sub Save
Saves the unit to the NotesDocument ContextDoc by using the save routines of the underlying
objects. If CustomerDataFields are set the unit saves the document disregarding the fact that
maybe no changes have been taken place.
- See also:
- History:
| 31.MAY.2000 | method | setAutoRefreshed used to disable not neccessary computations of the correspondence functionality
this is inserted for performance reasons
|
SaveToPredefinedFields
Public Function SaveToPredefinedFields As Integer
Save attributes to predefined fields. The fieldnames correspond to the forms LSAContact
and LSAOrganization in LSB-Address
- Returns:
| boolean | true, if a field in the document has been changed
|
- History:
| 25.JUL.2000 | RGR | fieldname DocType changed to LSADocType
|
| 24.JUL.2000 | RGR | write LSC-fields to disk
|
| 31.MAY.2000 | RGR | temporary variable to access getDisplayName function only once
|
SetCustomerDataField
Public Sub SetCustomerDataField(field As String,value As Variant)
Set the data for a free data field as specified by the customer. If this function is
used and the save routine is called then the document is saved even if
no changes has taken place.
- Parameters:
| Field | String | the fieldname of the field to be set
|
| Value | String | the value set into the field
|
getCustomerDataField
Public Function getCustomerDataField(fieldname As String) As Variant
Get the data from a free data field as specified by the customer
- Parameters:
| fieldname | String | the name of the field to be read
|
- Returns:
| Variant | the value found in the field
|
| Top | LotusScript Doc |
| © Lotus Professional Services |
| generated on : 05-Apr-01 8:45:33 AM |